Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

Maintain Authorized Events

Overview

This is the reference documentation for the administration menu item: Site Structure→Authorized Events

This function is used by the administrator to maintain the authorized events defined for the current site.

The authorized events can be created automatically when they first are checked by the runtime or manually using this menu item.

Note that the authorized event named *DEFAULT is used by the runtime to automatically create undefined authorized events when they are first used. By changing this event, you change the values that will be assigned to all the automatically created events. If you delete or rename this event, a new *DEFAULT event will be created when an undefined authorized event is being referenced.

Grid Page

The grid shows information about the authorized events currently defined for the site.

The grid is ordered alphabetically by "Event implementation name". You can position on an "Event implementation name" by entering the start of the name in the "Start with" field and press "Find".

You can search on "Event implementation name" and "Description" by entering a search text in the 'Search for' field and press Find.

Choosing a role or in the drop-down lists for "Events for role" will only show events with the chosen role assigned.

Choosing a value in the "Allowed for" drop-down list will show the events with the specified status.

By selecting a value in the "Show" drop-down list will limit the list to showing only events that has roles assigned or events that has no roles assigned.

Update

Basic Information

The page shows all the information about the event, and it can be updated.

Delete

The page shows the available information for the authorized event with the option of confirming the delete of the event.

Deleting the event physically removes the event and all it's relation to roles from the database.

Note that if the event is used (a page showing the event is loaded or the event is called) after the authorized event record has been deleted, a new event will be created automatically based on the *DEFAULT event.

An alternative to deleting the event is to set "Allowed for" to "No users" - this blocks all access to the event. 

Insert

Used to create a new authorized event.

Note that the "Event implementation name" must be the implementation name of the event handler.

Default value for "Allowed for" is "Users with roles". This means that the event will be available for sessions that has one or more of the roles that is assigned to the authorized event.

Assign Roles

For each authorized event you can assign roles. It is possible to assign an unlimited number of roles.

These roles will only have effect if "Allowed for" is set to "Users with roles". If another value is specified, you can still assign roles to the event - but it will not have any effect until you change the value for "Allowed for".

By pressing the Roles button in the grid or on the update page, a popup window is shown.

This popup window has two grids, the left shows the roles specified for the site, while the right shows the roles currently assigned to the event.

You add or remove roles for the event by selecting the roles in the grid and press Add/Remove or by using the Add all/Remove all buttons.

Please note that the roles are not assigned or removed before the Apply button is pressed. If you press the Cancel button or closes the popup window, no changes will be made to the roles assigned to the event.

Fields

The following fields are used on the pages:

Event implementation name

The implementation name of the authorized event.

This is also the text used in the /(%IFAUTHEVENT-...) markers in the template.

Allowed for

This status field has three values:

"All users" - All sessions will have access to the event. The effect of this is the same as if the event hasn't bee declared as an authorized event.

"Users with roles" - Only sessions that has one or more of the roles that has been assigned to the authorized event will have access to the event.

"No users" - No sessions will have access to the event.

Description

An optional text describing the event.

Comment

A comment used for assigning more information to the event.

Related Information

Authorized Events - Background
A document containing the basic information about the authorized events feature of WebsydianExpress
Authorized Events - Example
A document containing an example showing the intended use of the authorized events feature in WebsydianExpress.